

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>pysimm.forcefield.forcefield module &mdash; pysimm 0.2 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="pysimm 0.2 documentation" href="index.html"/>
        <link rel="up" title="pysimm.forcefield package" href="pysimm.forcefield.html"/>
        <link rel="next" title="pysimm.forcefield.gaff module" href="pysimm.forcefield.gaff.html"/>
        <link rel="prev" title="pysimm.forcefield.dreiding module" href="pysimm.forcefield.dreiding.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> pysimm
          

          
          </a>

          
            
            
              <div class="version">
                0.2
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="pysimm.html">pysimm package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="pysimm.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="pysimm.apps.html">pysimm.apps package</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="pysimm.forcefield.html">pysimm.forcefield package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="pysimm.forcefield.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="pysimm.forcefield.html#module-pysimm.forcefield">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pysimm.models.html">pysimm.models package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pysimm.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="pysimm.html#module-pysimm">Module contents</a></li>
</ul>
</li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index.html">pysimm</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          

 



<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html">Docs</a> &raquo;</li>
      
          <li><a href="pysimm.html">pysimm package</a> &raquo;</li>
      
          <li><a href="pysimm.forcefield.html">pysimm.forcefield package</a> &raquo;</li>
      
    <li>pysimm.forcefield.forcefield module</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/pysimm.forcefield.forcefield.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="module-pysimm.forcefield.forcefield">
<span id="pysimm-forcefield-forcefield-module"></span><h1>pysimm.forcefield.forcefield module<a class="headerlink" href="#module-pysimm.forcefield.forcefield" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="pysimm.forcefield.forcefield.Forcefield">
<em class="property">class </em><code class="descclassname">pysimm.forcefield.forcefield.</code><code class="descname">Forcefield</code><span class="sig-paren">(</span><em>file_=None</em>, <em>format=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/forcefield/forcefield.html#Forcefield"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Base Forcefield class definition.
Initialize with force field xml file.</p>
<dl class="attribute">
<dt id="pysimm.forcefield.forcefield.Forcefield.ff_class">
<code class="descname">ff_class</code><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.ff_class" title="Permalink to this definition">¶</a></dt>
<dd><p>force field class (1 or 2)</p>
</dd></dl>

<dl class="attribute">
<dt id="pysimm.forcefield.forcefield.Forcefield.ff_name">
<code class="descname">ff_name</code><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.ff_name" title="Permalink to this definition">¶</a></dt>
<dd><p>force field name</p>
</dd></dl>

<dl class="attribute">
<dt id="pysimm.forcefield.forcefield.Forcefield.particle_types">
<code class="descname">particle_types</code><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.particle_types" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="pysimm.utils.html#pysimm.utils.ItemContainer" title="pysimm.utils.ItemContainer"><code class="xref py py-class docutils literal"><span class="pre">ItemContainer</span></code></a> for particle_types</p>
</dd></dl>

<dl class="attribute">
<dt id="pysimm.forcefield.forcefield.Forcefield.bond_types">
<code class="descname">bond_types</code><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.bond_types" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="pysimm.utils.html#pysimm.utils.ItemContainer" title="pysimm.utils.ItemContainer"><code class="xref py py-class docutils literal"><span class="pre">ItemContainer</span></code></a> for bond_types</p>
</dd></dl>

<dl class="attribute">
<dt id="pysimm.forcefield.forcefield.Forcefield.angle_types">
<code class="descname">angle_types</code><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.angle_types" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="pysimm.utils.html#pysimm.utils.ItemContainer" title="pysimm.utils.ItemContainer"><code class="xref py py-class docutils literal"><span class="pre">ItemContainer</span></code></a> for angle_types</p>
</dd></dl>

<dl class="attribute">
<dt id="pysimm.forcefield.forcefield.Forcefield.dihedral_types">
<code class="descname">dihedral_types</code><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.dihedral_types" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="pysimm.utils.html#pysimm.utils.ItemContainer" title="pysimm.utils.ItemContainer"><code class="xref py py-class docutils literal"><span class="pre">ItemContainer</span></code></a> for dihedral_types</p>
</dd></dl>

<dl class="attribute">
<dt id="pysimm.forcefield.forcefield.Forcefield.improper_types">
<code class="descname">improper_types</code><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.improper_types" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="pysimm.utils.html#pysimm.utils.ItemContainer" title="pysimm.utils.ItemContainer"><code class="xref py py-class docutils literal"><span class="pre">ItemContainer</span></code></a> for improper_types</p>
</dd></dl>

<dl class="method">
<dt id="pysimm.forcefield.forcefield.Forcefield.from_json">
<code class="descname">from_json</code><span class="sig-paren">(</span><em>json_file</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/forcefield/forcefield.html#Forcefield.from_json"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.from_json" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pysimm.forcefield.forcefield.Forcefield.from_xml">
<code class="descname">from_xml</code><span class="sig-paren">(</span><em>file_</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/forcefield/forcefield.html#Forcefield.from_xml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.from_xml" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pysimm.forcefield.forcefield.Forcefield.write_json">
<code class="descname">write_json</code><span class="sig-paren">(</span><em>out</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/forcefield/forcefield.html#Forcefield.write_json"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.write_json" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pysimm.forcefield.forcefield.Forcefield.write_xml">
<code class="descname">write_xml</code><span class="sig-paren">(</span><em>out</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/forcefield/forcefield.html#Forcefield.write_xml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.forcefield.forcefield.Forcefield.write_xml" title="Permalink to this definition">¶</a></dt>
<dd><p>pysimm.forcefield.Forcefield.write</p>
<p>Write Forcefield object to xml format.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>out</strong> &#8211; file name to write</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="pysimm.forcefield.gaff.html" class="btn btn-neutral float-right" title="pysimm.forcefield.gaff module" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="pysimm.forcefield.dreiding.html" class="btn btn-neutral" title="pysimm.forcefield.dreiding module" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2017, https://pysimm.org.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'0.2',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>